---
title: clsImageImport
summary: API reference for clsImageImport.
status: draft
owner: SAIF Claims BOF team
last_reviewed: 2026-08-21
library: SAIF.Services.Imaging.Import
reference_type: embedded
---

# clsImageImport

`clsImageImport` is the sole public type in this library — a `<Serializable()>` plain data holder that models all metadata needed to import/index a document image (plus related task and legal-case linkage) into the OnBase imaging system, and exposes a `ToString()` method that flattens that state into a `KEY=VALUE` text payload consumed by calling libraries such as `SAIF.Services.Printing`.* It performs no validation, persistence, or transport of its own — producing and delivering the serialized payload to the external imaging system is the caller's responsibility.*

## Purpose
- Hold batch/document identity, claim/policy linkage, agency/producer linkage, legal-case linkage, document metadata, task/workflow metadata, and audit/system fields for a single imaging-import job as public auto-implemented properties.
- Expose named OnBase document type/sub-type classification constants (`UseOnBaseDocTypes`, `OnBaseType*`, `OnBaseSubType*`) for callers to reference when populating type/sub-type properties.*
- Serialize the populated instance into a `KEY=VALUE\r\n`-delimited text payload via `ToString()`, applying blank-out formatting rules for unset dates and non-positive numeric defaults ([BR-IMG-001](../../business-rules.md#br-img-001-blank-out-unset-date-values-in-serialized-output), [BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output)).

## Context
- Namespace: `SAIF.Services.Imaging.Import`
- Assembly/package: `SAIF.Services.Imaging.Import` (embedded/source-compiled project output; no NuGet package pipeline exists for this library)*

## Public members

| Member | Signature | Purpose |
| --- | --- | --- |
| `UseOnBaseDocTypes` | `Public Const UseOnBaseDocTypes As String = "OnBase16"` | Identifies the OnBase document-type set version this class targets when populating type/sub-type fields.* |
| `OnBaseTypeClIndemity` | `Public Const OnBaseTypeClIndemity As String = "CL - Indemnity"` | Named OnBase document-type value for claim indemnity documents, for callers to assign to `ImageDocumentTypeCode`.* |
| `OnBaseTypeClAdministrative` | `Public Const OnBaseTypeClAdministrative As String = "CL - Administrative"` | Named OnBase document-type value for claim administrative documents.* |
| `OnBaseTypeClFROI` | `Public Const OnBaseTypeClFROI As String = "CL - FROI"` | Named OnBase document-type value for First Report of Injury documents.* |
| `OnBaseTypeClWorker` | `Public Const OnBaseTypeClWorker As String = "CL - Worker"` | Named OnBase document-type value for worker-related claim documents.* |
| `OnBaseSubTypeCorrespondence` | `Public Const OnBaseSubTypeCorrespondence As String = "Correspondence"` | Named OnBase document-sub-type value for correspondence documents.* |
| `OnBaseSubType1502` | `Public Const OnBaseSubType1502 As String = "1502"` | Named OnBase document-sub-type value for form 1502 documents.* |
| `OnBaseSubTypeSaifCreated801` | `Public Const OnBaseSubTypeSaifCreated801 As String = "SAIF created 801"` | Named OnBase document-sub-type value for SAIF-created 801 form documents.* |
| `OnBaseSubTypeWcdHistory` | `Public Const OnBaseSubTypeWcdHistory As String = "WCD History"` | Named OnBase document-sub-type value for WCD history documents.* |
| `BatID` | `Public Property BatID() As String` | Batch identifier for the imaging batch this import belongs to. |
| `ClaimID` | `Public Property ClaimID() As Decimal` | Internal claim identifier linked to the imported document. |
| `ClaimNum` | `Public Property ClaimNum() As String` | Business-facing claim number linked to the imported document. |
| `CommentText` | `Public Property CommentText() As String` | Free-text comment attached to the import job. |
| `CreateUser` | `Public Property CreateUser() As String` | User ID recorded as the creator of the import job, for audit purposes. |
| `DiscoveryFlag` | `Public Property DiscoveryFlag() As String` | Flag marking the document as subject to legal discovery. |
| `DisplayField1` / `DisplayField2` / `DisplayField3` | `Public Property DisplayField1/2/3() As String` | Free-form display fields surfaced to the imaging system's index/search UI. |
| `DocumentDate` | `Public Property DocumentDate() As Date` | Date the document itself was created/dated; serialized blank when at the unset sentinel ([BR-IMG-001](../../business-rules.md#br-img-001-blank-out-unset-date-values-in-serialized-output)). |
| `DocumentDateDays` | `Public Property DocumentDateDays() As Decimal` (default `7`) | Day-count threshold associated with the document date; serialized blank when not greater than `0` ([BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output)). |
| `ImageCategoryCode` | `Public Property ImageCategoryCode() As String` | Imaging system category classification code for the document. |
| `ImageDeleteFlag` | `Public Property ImageDeleteFlag() As String` | Flag indicating the imported image should be marked for deletion. |
| `ImageDocumentTypeCode` | `Public Property ImageDocumentTypeCode() As String` | Document-type classification code, typically populated from the `OnBaseType*` constants. |
| `ImageIndexFlag` | `Public Property ImageIndexFlag() As String` (default `"Y"`) | Flag controlling whether the imaging system indexes the document. |
| `ImageFileCode` | `Public Property ImageFileCode() As String` (default `"CLAIM"`) | Imaging file/queue classification code the import is routed to. |
| `ImageSeqNum` | `Public Property ImageSeqNum() As Decimal` | Sequence number for the image within its batch; serialized blank when not greater than `0` ([BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output)). |
| `NPages` | `Public Property NPages() As Decimal` (default `1`) | Page count of the imaged document; serialized blank when not greater than `0` ([BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output)). |
| `PolicyNum` | `Public Property PolicyNum() As Decimal` | Policy number linked to the imported document; serialized blank when not greater than `0` ([BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output)). |
| `ReceivedDate` | `Public Property ReceivedDate() As Date` | Date the document (e.g., email attachment) was received; serialized blank when at the unset sentinel ([BR-IMG-001](../../business-rules.md#br-img-001-blank-out-unset-date-values-in-serialized-output)). |
| `ImageDocumentNameCode` | `Public Property ImageDocumentNameCode() As String` | Imaging system document-name classification code. |
| `ExternalViewCode` | `Public Property ExternalViewCode() As String` | Code controlling whether/how the document is visible to external viewers. |
| `SystemGeneratedFlag` | `Public Property SystemGeneratedFlag() As String` (default `"Y"`) | Flag indicating the import job was generated by a system process rather than a manual action. |
| `AgencyID` | `Public Property AgencyID() As String` | Identifier of the agency associated with the document. |
| `ProducerID` | `Public Property ProducerID() As String` | Identifier of the producer associated with the document. |
| `GroupAssociationCode` | `Public Property GroupAssociationCode() As String` | Code linking the document to a policy/group association. |
| `Spec` | `Public Property Spec() As String` | Specification/classification value passed through to the imaging system. |
| `SLevel` | `Public Property SLevel() As String` | Security/sensitivity level classification for the document.* |
| `TaskCategory` | `Public Property TaskCategory() As String` | Category of the workflow task associated with this import. |
| `TaskDate` | `Public Property TaskDate() As Date` | Due/associated date for the workflow task; serialized blank when at the unset sentinel ([BR-IMG-001](../../business-rules.md#br-img-001-blank-out-unset-date-values-in-serialized-output)). |
| `TaskMailIDList` | `Public Property TaskMailIDList() As String` | List of mail/user IDs to notify for the associated task. |
| `TaskPriority` | `Public Property TaskPriority() As String` (default `"MED"`) | Priority level of the associated workflow task. |
| `TaskSecurity` | `Public Property TaskSecurity() As String` | Security classification applied to the associated workflow task. |
| `TaskText` | `Public Property TaskText() As String` | Free-text description of the associated workflow task. |
| `PolicyAccount` | `Public Property PolicyAccount() As String` | Policy account identifier linked to the imported document. |
| `PolicySecuredFlag` | `Public Property PolicySecuredFlag() As String` (default `"N"`) | Flag indicating whether the linked policy is secured/restricted. |
| `AffiliationId` | `Public Property AffiliationId() As Decimal` | Identifier linking the document to a legal-case affiliation; serialized blank when not greater than `0` ([BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output)). |
| `LegalCaseId` | `Public Property LegalCaseId() As Decimal` | Internal identifier of the linked legal case; serialized blank when not greater than `0` ([BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output)). |
| `LegalCaseNum` | `Public Property LegalCaseNum() As String` | Business-facing legal case number. |
| `LegalCopyToClaimFlag` | `Public Property LegalCopyToClaimFlag() As String` | Flag indicating the document should also be copied to the claim's own imaging record. |
| `LegalDistributionFlag` | `Public Property LegalDistributionFlag() As String` | Flag controlling distribution of the document within legal-case workflows. |
| `ToString` | `Public Overrides Function ToString() As String` | Builds and returns the `KEY=VALUE\r\n`-delimited serialization of all property values, applying [BR-IMG-001](../../business-rules.md#br-img-001-blank-out-unset-date-values-in-serialized-output) and [BR-IMG-002](../../business-rules.md#br-img-002-blank-out-non-positive-numeric-defaults-in-serialized-output); see [Serialize import metadata to key-value text](../../operations/serialize-import-metadata-to-key-value-text.md). |

## Behavioral notes
- No constructors, interfaces, events, or shared/static members are declared; the class relies on the implicit public parameterless constructor with property initializers.
- The class performs no validation of its own property values; the only conditional logic is the blank-out formatting inside `ToString()`.
- The exact external system that consumes the serialized payload is inferred from `OnBase*` constant naming only and was not confirmed via a receiving integration point within this library's scope.**

## Constraints and usage notes
- Callers must populate desired properties before calling `ToString()`; unset date properties default to `Date.MinValue` and unset numeric properties default to `0` (or their documented defaults), both of which are blanked out rather than serialized literally.
- This class does not write, transmit, or persist the serialized payload — delivering it to the external imaging system is the caller's responsibility.*

## Related documentation
- [Index](../../index.md)
- [Overview](../../overview.md)
- [Business rules](../../business-rules.md)
- [Serialize import metadata to key-value text](../../operations/serialize-import-metadata-to-key-value-text.md)

> **Note:** Statements marked with * were inferred from code structure, naming conventions, or
> contextual evidence where direct confirmation was not available in source artifacts. Statements
> marked with ** could not be confirmed; treat as unknown until verified.

## Sources
- `SAIF.Services.Imaging.Import\clsImageImport.vb`
- `.saifdocgen\state\runs\20260821-113120-claims-bof-web-legal\analysis\TSK010-analysis.md`